Esx Settings Defaults Clusters Policies Apply Effective EffectivePolicySpec

Esx Settings Defaults Clusters Policies Apply Effective EffectivePolicySpec
Esx Settings Defaults Clusters Policies Apply Effective EffectivePolicySpec

The Esx Settings Defaults Clusters Policies Apply Effective EffectivePolicySpec schema contains properties that describe the effective policies to be used when the software and configuration specification documents are applied to ESXi clusters.

This schema was added in vSphere API 7.0.0.0.

JSON Example
{
    "failure_action": {
        "action": "string",
        "retry_delay": 0,
        "retry_count": 0
    },
    "pre_remediation_power_action": "string",
    "enable_quick_boot": false,
    "disable_dpm": false,
    "disable_hac": false,
    "evacuate_offline_vms": false,
    "enforce_hcl_validation": false,
    "parallel_remediation_action": {
        "enabled": false,
        "max_hosts": 0
    },
    "enforce_quick_patch": false,
    "config_manager_policy_spec": {
        "serial_remediation": false
    }
}
failure_action
Required

What action is to be taken if entering maintenance mode fails on a given host of the cluster.

This property was added in vSphere API 7.0.0.0.

string
pre_remediation_power_action
Required

Specifies what should be done to the power state of the VM before entering maintenance mode.

For more information see: Esx Settings Defaults Clusters Policies Apply Effective EffectivePolicySpec PreRemediationPowerAction.

This property was added in vSphere API 7.0.0.0.

boolean
enable_quick_boot
Required

Enable Quick Boot during remediation in the cluster.

This property was added in vSphere API 7.0.0.0.

boolean
disable_dpm
Required

Disable DPM on the cluster.

This property was added in vSphere API 7.0.0.0.

boolean
disable_hac
Required

Disable HA Admission control on the cluster.

This property was added in vSphere API 7.0.0.0.

boolean
evacuate_offline_vms
Required

Evacuate powered off/suspended VMs when attempting maintenance mode.

This property was added in vSphere API 7.0.0.0.

boolean
enforce_hcl_validation
Optional

Enforce Hcl validation, when applicable, to prevent remediation if hardware compatibility issues are found.

This property was added in vSphere API 7.0.1.0.

This property is optional because it was added in a newer version than its parent node.

parallel_remediation_action
Optional

Enable parallel remediation of hosts in maintenance mode. Set max hosts when applicable.

This property was added in vSphere API 8.0.0.1.

If missing or null, parallel remediation will not happen.

boolean
enforce_quick_patch
Optional

Enforce quick patch on the cluster for images that support it.

This property was added in vSphere API 8.0.3.0.

This property is optional because it was added in a newer version than its parent node.

config_manager_policy_spec
Optional

Configure settings applicable to the com.vmware.esx.settings.clusters.Configuration.apply API.

This property was added in vSphere API 8.0.3.0.

This property is optional because it was added in a newer version than its parent node.

Returned By